Gibt es eine API zur Datenübergabe an EinfachX?

Eine API für die EinfachX XCloud befindet sich gerade in der Einführung.
Perspektivisch planen wir die API ebenfalls für den XCreator anzubieten.

Welche Möglichkeiten bietet mir die API?

• Die API ermöglicht die Erstellung von XRechnungen.
• Die übergebenen Rechnungsdaten werden in eine XRechnung umgewandelt und der Inhalt der xml-Datei als Base64-String zurückgegeben.
• Zwischen Umwandlung und Rückgabe wird die XRechnung - wie auch bei XRechnungserstellung über unsere UI - mittels KoSIT-Validator überprüft. Falls diese Validierung Fehler aufzeigt, wird eine entsprechende Meldung zurückgegeben. Anders als bei der Erstellung über unsere UI kann diese erweiterte Validierung jedoch mittels API wahlweise auch übersprungen werden.
• Wahlweise kann auch die Kompaktvorschau erstellt und zurückgegeben werden. In diesem Fall ist der Inhalt der entsprechenden html-Datei ebenfalls als Base64-String in der Serverantwort enthalten.
  
  

Wie ist die API aufgebaut?

Es stehen zwei Modelle zur Übertragung der Rechnungsdaten an die API zur Verfügung.

• SyntaxInvoice: Dieses Modell ist sehr umfangreich und bietet nahezu alle Felder und Möglichkeiten, die im "Standard XRechnung" vorgesehen sind. Die dadurch entstehende Komplexität macht eine Implementierung auf Kundenseite flexibler, aber auch aufwendiger als die Benutzung des SimplifiedInvoices
• SimplifiedInvoice: Dies ist ein vereinfachtes Rechnungsmodell mit dem Ziel, die meisten Standardanforderungen mit möglichst geringem Implementierungsaufwand abzudecken.

Genaue Infos zum Aufbau der API stellen wir in unseren API-Docs, sowie auf einer interaktiven Swagger-Seite zur Verfügung:
API-Docs: https://cloud.einfach-xrechnung.de/api-docs
Swagger: https://cloud.einfach-xrechnung.de/swagger

Für beide Invoice-Modelle stehen die API-Endpunkte "Get SampleRequest" und "Post Create" zur Verfügung. Der SampleRequest-Endpunkt liefert einen Beispieldatensatz zurück, der als Body-Parameter für den Create-Endpunkt genutzt werden kann.

Sowohl die API-Docs als auch die Swagger-Seite ermöglichen den direkten Download des zu verwendenden Json-Schemas. Anhand dieses Schemas kann der clientseitige Code für die Datenklassen über gängige Tools für die meisten Programmiersprachen generiert werden.

Wie bekomme ich Zugang zur API?

Um Rechnungen über die API erstellen zu können, benötigen Sie einen API-Key. Diesen können Sie über Ihren XCloud-Account im Bereich Profil --> API --> neu anlegen.
Beim Erstellen eines API-Keys wird Ihrem Account auch einmalig ein Kontingent zur API-Nutzung (API-Credits) zur Verfügung gestellt. Während der Einführung ist die Nutzung der API kostenlos möglich. Sofern Ihnen das freigeschaltete Kontingent nicht ausreicht, kontaktieren Sie uns bitte und wir weisen Ihnen mehr Credits zu.

Kann ich die API auch ohne XCloud-Account nutzen?

Zur Verwaltung Ihrer API-Keys ist ein XCloud-Account zwingend erforderlich. Es ist jedoch nicht notwendig, dass der XCloud-Account mit einem Zugangsschlüssel aktiviert wurde. Sofern Ihr Account über ein ausreichendes API-Kontingent verfügt, kann die API auch mit einem "abgelaufenen" XCloud-Test-Account genutzt werden.

Wie wird die Nutzung der API berechnet?

Während der Einführungsphase ist die Nutzung der API kostenlos möglich. Anschließend planen wir Volumentarife anzubieten, mit denen - je nach gewähltem Tarif - die Erstellung einer bestimmten Anzahl an Rechnungen pro Monat/Jahr möglich sind.